﻿// ———————————————————————–
// <copyright file="LocationPointType.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// LocationPointType.cs:
// A data type for a 3D geometric point, defined by a single coordinate tuple with values from
// the WGS84 coordinate note system.
// Project: IC.NET - EDXL Library
//
// Language:    C#, .NET 4.0
// Platform:    Windows 7, VS 2012
// Author:      Jim Cronin MITRE Bedford

/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)

using System;
using System.Xml;
using GeoOASISWhereLib;

namespace EDXLSharp.NIEMCore
{
  /// <summary>
  /// A data type for a 3D geometric point, defined by a single coordinate tuple with values from
  /// the WGS84 coordinate note system.
  /// </summary>
  public abstract class LocationPointType : ComplexTypeBase
  {
    public GMLPoint Point;

    /// <summary>
    /// Writes this Object to an inline XML Document
    /// </summary>
    /// <param name="xwriter">Valid XMLWriter</param>
    /// <exception cref="System.ArgumentNullException">Thrown if xwriter is null</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public override void WriteXML(XmlWriter xwriter)
    {
      if (xwriter == null)
      {
        throw new ArgumentException("xwriter");
      }

      this.Validate();

      xwriter.WriteStartElement(this.ElementPrefix, this.ElementName, this.ElementNamespace);
      this.Point.WriteXMLForPublicUse(xwriter);
      xwriter.WriteEndElement();
    }

    /// <summary>
    /// Reads this Object's values from an XML nodelist
    /// </summary>
    /// <param name="rootnode">root XML Node of the Object element</param>
    /// <exception cref="System.ArgumentNullException">Thrown if rootnode is null</exception>
    /// <exception cref="System.ArgumentException">Thrown if the rootnode is not the correct type</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object or XML fails to validate</exception>
    public override void ReadXML(XmlNode rootnode)
    {
      if (rootnode == null)
      {
        throw new ArgumentNullException("rootnode");
      }
      if (rootnode.LocalName != this.ElementName)
      {
        throw new ArgumentException("Unexpected element " + rootnode.LocalName + " instead of " + this.ElementName);
      }

      bool pointFound = false; //there should only be one
      foreach (XmlNode node in rootnode.ChildNodes)
      {
        switch (node.LocalName)
        {
          case "Point":
            if (pointFound)
            {
              throw new ValidationException("More than one Point element found in " + this.ElementName);
            }
            this.Point = new GMLPoint();
            this.Point.ReadXML(node);
            pointFound = true;
            break;
          default:
            throw new ArgumentException("Unexpected node " + node.LocalName + " in element " + this.ElementName);
        }
      }
      Validate();
    }

    /// <summary>
    /// Validates This Message element For Required Values and Conformance
    /// </summary>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if the object fails to validate</exception>
    public override void Validate()
    {
      if (Point == null)
      {
        throw new ValidationException("Missing required element Point from element " + ElementName);
      }
      if (Point.Pos == null)
      {
        throw new ValidationException("Missing required element pos from Point");
      }
      if (Point.Pos.Pos.Count != 3)
      {
        throw new ValidationException("There should be a latitude, longitude, and altitude included for the position.");
      }
      if (Point.SrsName == null || Point.SrsName.AbsoluteUri != "http://metadata.ces.mil/mdr/ns/GSIP/crs/WGS84E_3D")
      {
        throw new ValidationException("Must have the srsName equal to http://metadata.ces.mil/mdr/ns/GSIP/crs/WGS84E_3D");
      }
      if (Point.ID == null)
      {
        throw new ValidationException("Must have an id attribute");
      }
    }
  }
}